Skip to main content

Webhook: ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER

Обзор​

Webhook ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER срабатывает, когда числовое действие превышает заранее определённый диапазон (например, значение температуры, превышающее безопасный лимит). Этот webhook помогает отслеживать такие события, позволяя системам или пользователям предпринимать корректирующие меры для предотвращения возможных проблем.

Цель​

Этот webhook служит системой уведомлений, которая оповещает пользователей или системы, когда числовые значения выходят за допустимые пределы. Примеры включают отслеживание работы оборудования (например, температуры, давления) или другие ситуации, когда превышение диапазона может привести к ошибкам или сбоям.

Формат запроса​

Webhook отправляет HTTP POST запрос с следующим JSON-пейлоадом:

{
   "entityId": "8d894ccc-66aa-41db-8101-f1e8c162688b",
   "type": "ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER",
   "createdAt": "2024-12-16T12:24:02.313Z",
   "data": {
      "id": "8d894ccc-66aa-41db-8101-f1e8c162688b",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T12:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Задача 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "8f7882dd-16e9-4354-8284-b5ad22bf2ea9",
      "actionId": "c57bf98e-ddd5-440a-a2ff-9f395f81e850"
   },
   "id": 201
}

Ключевые свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор события.
  • type: Указывает тип webhook (ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER).
  • createdAt: Временная метка, когда webhook был создан, в формате ISO 8601.
  • data: Содержит подробную информацию о действии, выходящем за пределы диапазона.

Поля данных​

Детали действия​

  • id: Уникальный идентификатор конкретного действия.
  • organizationId: Идентификатор организации, связанной с действием.
  • locationId: Идентификатор локации, где произошло событие.
  • startAt: Время начала действия в формате ISO 8601.
  • endAt: Время окончания действия в формате ISO 8601.
  • name: Название задачи, связанной с действием.
  • assigneeIds: Список идентификаторов пользователей, назначенных на эту задачу или действие.
  • recurrenceRule: Правила повторения задачи (если имеются). Для этого события это поле равно null.
  • stepId: Идентификатор конкретного шага, связанного с действием.
  • actionId: Идентификатор действия, вызвавшего ошибку из-за выхода за пределы диапазона.

Пример ответа​

Пример пейлоада для успешного срабатывания webhook:

{
   "entityId": "8d894ccc-66aa-41db-8101-f1e8c162688b",
   "type": "ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER",
   "createdAt": "2024-12-16T12:24:02.313Z",
   "data": {
      "id": "8d894ccc-66aa-41db-8101-f1e8c162688b",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T12:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Задача 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "8f7882dd-16e9-4354-8284-b5ad22bf2ea9",
      "actionId": "c57bf98e-ddd5-440a-a2ff-9f395f81e850"
   }
}

Преимущества​

  1. Предотвращение ошибок: Помогает снизить риски, уведомляя заинтересованные стороны о выходе числовых значений за пределы допустимых лимитов.
  2. Автоматический мониторинг: Позволяет системам автоматически реагировать на выход значений за пределы диапазона, инициируя корректирующие действия или оповещения.
  3. Увеличенная видимость: Оповещает пользователей о возможных проблемах, улучшая контроль и управление.

Webhook ACTION_SPECIFIED_OUT_OF_RANGE_NUMBER предоставляет важный механизм мониторинга, чтобы числовые значения оставались в пределах заранее определённых безопасных границ.